XIQS Clear Campaign Contacts

From IQsimWiki

Jump to: navigation, search

XIQS Clear Campaign - Campaign Management

Description
clearXIQSCampaign ( Long id_campaign , [Long maxnb] )
Clear an existing campaign object. Clear means all campaign's statistics are cleared (set to 0), AND recipient list is deleted.
An optional parameter (maxnb) can be specified; in this case: if deleted_entries_nb < total_entries_nb then campaign object is not deleted
Parameters
Long id_campaign
the campaign id to clear
[Long maxnb]
the maximum number of recipient entries to delete
Return Values

Long deletednb - number of row deleted

Error Data structure ( Error Management )
Possible failure code returns
See Also
resetXIQSCampaign
Personal tools
Namespaces
Variants
Views
Actions
Navigation
XIQS XML Protocol
XIQS Framework Libraries
XIQS Command List